Skip to main content

Gửi tin nhắn theo cấu trúc khách hàng tự định nghĩa

Chúng tôi cung cấp một API gửi tin nhắn theo cấu trúc tự định nghĩa, dưới định danh của người dùng hoặc bot.

HTTP request​

POST https://{app_id}.api.piscale.com/open-api/v1.0/chat/messages

Request body​

Ví dụ
{
    "sender": {
        // "bot_id": "6872016393689131",
        "user_id": "30043"
    },
    "target": {
        // "user_ids": ["30043"]
        "thread_id": "62046069159700"
    },
    "body": {
        "text": "",
        "metadata": [
            {   
                "type": "custom_defined",
                "custom_name": "abczz", // Bạn tự định nghĩa
                "payload": "{}" // Bạn tự định nghĩa 
            }
        ],
        "custom_notify": {
            "title": "Custom title",
            "subtitle": "Custom subtitle",
            "avatar_url": "https://avatar_url.png",
            "image_url": "https://image_url.png"
        }
    }
}
TênKiểu dữ liệuMô tảBắt buộc
sender.bot_idstringGửi dưới định dạng bot✗
sender.user_idstringGửi dưới định danh user✗
target.user_idsarrayDanh sách các user_id nhận✗
target.thread_idstringMã cuộc hội thoại✗
body.textstringNội dung tin nhắn khi hiển thị ở định dạng văn bản✓
body.metadata[0].typestringPhải là custom_defined✓
body.metadata[0].custom_namestringTên kiểu tin nhắn tùy biến✓
body.metadata[0].payloadstringDữ liệu tin nhắn theo định dạng JSON✓
body.custom_notify.titlestringTiêu đề của thông báo tùy chỉnh✗
body.custom_notify.subtitlestringPhụ đề của thông báo tùy chỉnh✗
body.custom_notify.avatar_urlstringURL của hình ảnh đại diện được hiển thị trong thông báo✗
body.custom_notify.image_urlstringURL của hình ảnh chính được hiển thị trong thông báo✗
note
  • Bắt buộc thread_id hoặc ext_user_ids hoặc user_ids phải có dữ liệu.
  • Đích đến của tin nhắn sẽ được ưu tiên theo thứ tự thread_id, ext_user_ids, user_ids.
  • ext_user_ids tối đa 1000 phần tử.
  • user_ids tối đa 100 phần tử.
  • Metadata chỉ có 1 phần tử

Response​

Nếu thành công, bạn sẽ nhận được phản hồi.

Ví dụ
{
    "message_code": "M200",
    "message": "Success"
}
TênKiểu dữ liệuMô tả
message_codestringMã thông điệp. Xem chi tiết
messagestringNội dung mã thông điệp